home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / remote / mloc176.zip / MLOCATE.DOC < prev    next >
Text File  |  1991-09-10  |  16KB  |  447 lines
  1.  
  2.         ╓─────────────────────────────────────────────────────────────╖
  3.         ║   MLOCATE v1.76, (c)1990 SoftSpeed SoftWare - Anders Brink  ║
  4.         ║   910909,                             Released  9 Sep 1990  ║
  5.         ╙─────────────────────────────────────────────────────────────╜
  6.  
  7.  
  8.    Short description:
  9.  
  10.         This is THE Maximus v1.02 / Remote Access 1.01 online
  11.         "Locate File" replacement, with support for multiple
  12.         tasks and different configuration files.
  13.  
  14.         When running as a standalone utility the program assume
  15.         that it's the SysOp who are running and therefor bypasses
  16.         all locks and/or privilegie control.  Share/DV-aware.
  17.  
  18.  
  19.  
  20.    Copyright:
  21.  
  22.         This program is freeware, it's up to you what you
  23.         want to do with it, any bugs found is also yours.
  24.         IF you find any bugs, don't expect me to fix'em,
  25.         but I would be more than happy if you report any
  26.         "features" in the program behavior to me.
  27.  
  28.         COMPLAINTS >NUL
  29.  
  30.         You are more than welcome to send suggestions to:
  31.  
  32.                 Anders Brink, 2:205/203@fidonet
  33.  
  34.  
  35.  
  36.    Warning:
  37.  
  38.         Because of some ******* reason this program may not work
  39.         with Ray Gwinn's X00 fossil loaded, I suggest you use BNU.
  40.  
  41.         This program does NOT support Maximus barricaded areas or
  42.         extended barricaded areas, use privilegies and locks instead.
  43.  
  44.         This program supports Remote Access "Flags", and Security levels,
  45.         but NOT Remote Access 1.01 "Security Flags", yet...
  46.  
  47.         This program uses an anti-virus-check routine at startup,
  48.         may take a while on a slow lo-tech PC/XT machine, if you find
  49.         it annoying, buy yourself an 486/33. :-)
  50.         
  51.  
  52.  
  53.    Installation:
  54.  
  55.         Place MLOCATE.EXE and MLOCATE.CTL in your Maximus /RA directory,
  56.         edit MLOCATE.CTL to match your setup, NOT mine!
  57.  
  58.  
  59.    Maximus mode installation in MENUS.CTL:
  60.  
  61.  
  62.         Install MLOCATE.EXE like this in the file MENUS.CTL:
  63.  
  64.                 Xtern_Run C:\Max\Mlocate.Exe_%L_-S%W   Twit "Locate (fast)"
  65.  
  66.  
  67.         then compile your control file with the Maxmimus utility:
  68.  
  69.                 SILT MAX -m
  70.  
  71.  
  72.         Compile your data-file for all of your tasks (if any):
  73.  
  74.                 MLOCATE -M                   <task 0, single line BBS>
  75.         or
  76.                 MLOCATE -M -k1               <task 1>
  77.         or
  78.                 MLOCATE -M -k2 -DC:\Max\Ctl\ <task 2,
  79.                                               Mlocate.Ctl in C:\Max\Ctl\>
  80.  
  81.  
  82.         With Remote Access, edit your FILES menu with RAMENU.EXE:
  83.  
  84.  
  85.             ╒═══════════════════════════════ Edit Menu Item
  86.             │
  87.             │          1         2         3         4
  88.             │ 1234567890123456789012345678901234567890123456
  89.             │ ^L^ocate files        ;
  90.             │
  91.             │ E:\RA\MLOCATE.EXE -De:\ra\mlocate.ctl -P*P *H
  92.             │
  93.             │
  94.             │     User display
  95.             │     Action        Execute sub-program (Type 7)
  96.             │     Optional data
  97.             │     Hot-Key       L
  98.             │     Automatic     No
  99.             │     Colour        Colour example
  100.             │     Security      1
  101.             │     Flags-A       --------
  102.             │     Flags-B       --------
  103.             │     Flags-C       --------
  104.             │     Flags-D       --------
  105.  
  106.  
  107.             ╒═══════════════════════════════ Edit Menu Item
  108.             │
  109.             │          1         2         3         4
  110.             │ 1234567890123456789012345678901234567890123456
  111.             │ ^N^ew files           ;
  112.             │
  113.             │ E:\RA\MLOCATE.EXE -De:\ra\mlocate.ctl -* -P*P *H
  114.             │
  115.             │
  116.             │     User display
  117.             │     Action        Execute sub-program (Type 7)
  118.             │     Optional data
  119.             │     Hot-Key       N
  120.             │     Automatic     No
  121.             │     Colour        Colour example
  122.             │     Security      1
  123.             │     Flags-A       --------
  124.             │     Flags-B       --------
  125.             │     Flags-C       --------
  126.             │     Flags-D       --------
  127.  
  128.  
  129.         That's it!
  130.  
  131.  
  132.         NOTE: The command-line swiches *ARE* case sensitive!
  133.                                        ^^^^^
  134.  
  135.         If you run more than one task you could use the same
  136.         control-file for all your tasks, BUT... you still need
  137.         to specify a "task X" statement in the .CTL file, how you
  138.         solve that it in Remote Access mode I really don't give a sh*t. :-)
  139.  
  140.         And now, fire up (preferable) Maximus or RA and get impressed!
  141.         
  142.  
  143.  
  144.  
  145. This is a small part of my MENUS.CTL file:
  146.  
  147. Menu FILE
  148.         Title           FILE
  149.         MenuHeader      File
  150.         Area_Change     File                       Twit "Area Change"
  151.  
  152. ;;;; This is the old "Locate" command
  153. ;;;;    Locate                                     Twit "Locate file"
  154.         Xtern_Run C:\Max\Mlocate.Exe_%L_-k%k_-J%R_-S%W   Twit "Locate file"
  155.  
  156. ;;;; I showing you how it COULD be done
  157. ;;;; when MLOCATE.CTL are located in C:\Max\Ctl\
  158. ;;;;       Xtern_Run C:\Max\Mlocate.Exe_%L_-k%k_-DC:\Max\Ctl\_-J%R_-S%W Twit "Locate file"
  159.  
  160. ;;;; Allow the SysOp to re-compile on-line, if needed.
  161. ;;;;    Xtern_Run C:\Max\Mlocate.Exe_-M_-DC:\Max1  Sysop "$Re-Compile data"
  162.  
  163.         File_Titles                                Twit "File Titles"
  164.         Type                                   Disgrace "Type (show)"
  165.         Goodbye                                    Twit "Goodbye (log off)"
  166.         Download                               Disgrace "Download (receive)"
  167.         Upload                                 Disgrace "Upload (send)"
  168.         Statistics                                 Twit "Statistics"
  169.         Contents                                   Twit "Contents"
  170.         Display_File    Misc\Olzv              Disgrace "View Contents"
  171.         Raw                                       Sysop "Raw Directory"
  172.  
  173. ;;;;    Wow! it's working like NEWFILES too!
  174. ;;;;    Newfiles                               Disgrace "New files"
  175.         Xtern_Run C:\Max\Mlocate.Exe_%L_-k%k_-*_-J%R_-S%W Twit "New files"
  176.         File_Kill                                 Sysop "Kill file"
  177.         File_Hurl                                 Sysop "Hurl (move)"
  178.         Display_Menu    Main                       Twit "Main Menu"
  179.         Display_Menu    Message                    Twit "* Message Areas"
  180.         Display_File    Hlp\FileHelp               Twit "?help"
  181. End Menu
  182.  
  183.  
  184.  
  185.  
  186.  
  187.             ╔════════════════════════════════════════════╗
  188.             ║   Items in the control file, MLOCATE.CTL   ║
  189.             ╚════════════════════════════════════════════╝
  190.  
  191.         One BIG note here, if you DO specify Remote Access items in
  192.         the control-file, MLOCATE assume it's in RA-mode, else Maximus.
  193.         
  194.  
  195. ; wich task to work with
  196. task 0     
  197.  
  198. ; wich file to display when the user want some help
  199. helpfile   c:\max\hlp\mlochlp.bbs
  200.  
  201. ; wich file where the compiled data is written to and read from
  202. datafile   c:\max\mlocate.dat
  203.  
  204. ; where the Remote Access 1.01 file CONFIG.RA are located
  205. raconfig   c:\ra\config.ra
  206.  
  207. ; where the Remote Access 1.01 file FILES.RA are located
  208. rafiles    c:\ra\files.ra
  209.  
  210. ; where the Remote Access 1.01 file EXITINFO.BBS are located
  211. exitinfo   c:\ra\exitinfo.bbs
  212.  
  213. ; wich Maximus lastuser file to get user-info from
  214. lastuser   c:\max\lastuser.bbs
  215.  
  216. ; location of the Maximus AREA.DAT file
  217. areadat    c:\max\area.dat
  218.  
  219. ; location of the Maximus AREA.IDX file
  220. areaidx    c:\max\area.idx
  221.  
  222.  
  223. ; how to deal with files with incorrect dates
  224. ; this would let the faulty file time-stamp to be the date of compile -30 days
  225. errordate  -30
  226.  
  227. ; this would disable the "errordate" function
  228. errordate  0
  229.  
  230. ; this would let the faulty file time-stamp to be the date of compile +14 days
  231. errordate 14
  232.  
  233. ; define an alternate FILES.BBS for a certain area, for example CD-roms
  234. ; one note here, Maximus and Mlocate has FULL support for CD-roms,
  235. ; normally you wouldn't have need to use this...
  236. cd         89   c:\cd-file\cd89.bbs
  237. cd         90   c:\cd-file\cd90.bbs
  238.  
  239. ; exclude these file-areas from datafile,
  240. ; this could be used to hide certain areas.
  241. skip       1
  242. skip       10
  243. skip       1B   ; Maximus-mode
  244. skip       A0   ; also in Maximus-mode
  245. skip      129   ; RA-mode
  246. skip      200   ; also in RA-mode
  247.  
  248. <end of control file>
  249.  
  250.  
  251.  
  252.  
  253.  
  254.             ╔════════════════════════════════════════════╗
  255.             ║        SysOp keyboard control keys         ║
  256.             ╚════════════════════════════════════════════╝
  257.  
  258.  
  259.                 O - SNOOP mode OFF
  260.  
  261.                 N - SNOOP mode ON
  262.  
  263.                 A - Simultaneous keyboard and SNOOP mode on
  264.  
  265.             <Esc> - Keyboard OFF and/or users statistics
  266.  
  267.                 Any other key will display the users statistics
  268.  
  269.  
  270.  
  271.             ╔════════════════════════════════════════════╗
  272.             ║   Command-line arguments for MLOCATE       ║
  273.             ╚════════════════════════════════════════════╝
  274.  
  275. Command line arguments: (Note! These *ARE* case sensitive)
  276.  
  277.         ?               Displays a brief help-text.
  278.  
  279.         -M              Compile/create the datafile that are used by MLocate.
  280.                         Switches that will affect operation: -k<task> -d -Q
  281.                         Run this after every caller or once a day.
  282.  
  283.         -Q              Quiet compile, almost...
  284.  
  285.         -S              Set Snoop mode ON as default in remote mode.
  286.  
  287.         -k<task>        Task selection, use this to define wich
  288.                         configuration in MLOCATE.CTL to use.
  289.                         <task> is a number between 0 and 99.
  290.  
  291.         -k              Running locally,
  292.                         i.e. when running: MAX MAX -k
  293.  
  294.         -D<cfgpath>     Control file to use in this session,
  295.                         this overrides the default file MLOCATE.CTL.
  296.                         <cfgpath> are the config path to be used during
  297.                         this session. Ex.  -Dc:\max\ctl1\
  298.                         
  299.  
  300.         -p<port>        Defines wich COM-port (+1) to use when online.
  301.                         <port> defines wich port to use.
  302.                         Valid port-numbers are 0 to 15
  303.                         This parameter overrides the "port" information
  304.                         in MLOCATE.CTL. Ex: "-p0" is COM1
  305.  
  306.         -P<port>        Same as above... valid numbers are 1 to 16
  307.                         Ex: "-P2" is COM2
  308.  
  309.         -*              Perform the MECCA-like command NEWFILES.
  310.                         It may/will replace the Maximus NEWFILES.
  311.  
  312.         -J<commands>    This option will "JAM" commands into MLOCATE,
  313.                         just like the -J option in Maximus.
  314.                         To insert an ^M (Carrige Return) into the buffert
  315.                         you will have to insert a ";" or "|" character.
  316.  
  317.                           Example: MLOCATE -J*;01-12-90
  318.  
  319.                         will 'jam' in the commands NEWFILES from the
  320.                         1'st of December 1990.
  321.  
  322.                         If you use MAX.ABK.7 or later from 2:205/203 you will
  323.                         be able to pass the stacked commands to MLOCATE
  324.                         with the 'XTERN_???'  %R  parameter.
  325.  
  326.         -S<parm>        SNOOP ON "+" or SNOOP OFF "-" as default.
  327.         
  328.  
  329.     // Anders Brink // FidoNet 2:205/203 // SoftSpeed // 9 September 1991 //
  330.  
  331.  
  332. Bugfixes:
  333.  
  334.  
  335. 1.04ß   900816: Fixed the TTY/ANSI/AVATAR bug wich would send ANSI-sequenses
  336.                 to TTY users.
  337.  
  338.  
  339. 1.05ß   900817: Added LASTUSER and SKIP information in the control file,
  340.                 also fixed some command-line parameter bugs.
  341.  
  342.  
  343. 1.06ß   900818: Internal version, never released.
  344.  
  345.  
  346. 1.07ß   900819: Added datesearch when using the '*' newfiles command.
  347.                 Added '-*' for NEWFILES function.
  348.  
  349.  
  350. 1.08ß   900820: Some gliches in local mode fixed.
  351.  
  352.  
  353. 1.09ß   900821: Improved errorhandling and '-Q' quiet mode when compiling.
  354.  
  355.  
  356. 1.10ß   900823: Bugfix in COM routines, bugfix in date search input routine.
  357.  
  358.  
  359. 1.20    900906: Bugfix in the "?<file>" feature, it will now display the
  360.                 file description instead of garbage! :-)
  361.                 Some fixes in the 'intelligence' of the date-input routine.
  362.                 First official release.
  363.  
  364.  
  365. 1.40    901231  Fixed the 'real' Maximus feeling as in the Snoop and Keyboard
  366.                 functions. Status screen when in remote mode, simply press any
  367.                 key to show the user record.  Implemented support for
  368.                 DESQview and for SHARE in a network environment.
  369.                 
  370.  
  371. 1.50    910101  Implemented -J 'jam' parameter, this will pass (jam) 'stacked'
  372.                 commands into MLOCATE instead of using the keyboard.
  373.                 Implemented the "=" (more-off) option at the MORE? prompt.
  374.  
  375.  
  376. 1.60    910401  Implemented CD-ROM support, the configuration-verb "cd" would
  377.                 let you specify an alternate FILES.BBS.
  378.                 Implemented "errordate" correction, this would let you
  379.                 get around the fact that files with faulty dates will always
  380.                 give you a 'blinking' asterix on "L)ocate Newfiles".
  381.                 Proper time-check will now detect the users time online.
  382.  
  383.  
  384. 1.61    910402  Fixed a nasty "time-limit" bug that would freeze the computer.
  385.  
  386.  
  387. 1.64ß   910504  Remote Access 1.01 support.
  388.  
  389.  
  390. 1.65ß   910505  Removed "comport xx" support in MLOCATE.CTL, use command-line
  391.                 parameter "-p<0..3>" or "-P<1..4>" instead.
  392.  
  393.                 Running in local mode is detected by "-k" parameter or
  394.                 in LASTUSER.BBS "user.flag=0" or
  395.                 in EXITINFO.BBS "ExitInfo.Baud=0"
  396.  
  397.                 Implemented support for "A,B,C and D flags" in RA-mode.
  398.  
  399.                 The flags "PrivateSecurity Flags" in RA-mode is not
  400.                 yet implemented, sorry...
  401.  
  402. 1.70    910605  First public release of the Maximus/RA version.
  403.  
  404.  
  405. 1.71    910616  Fixed an ugly bug that would not allow TWIT areas
  406.                 in Maximus mode to be shown to the user.
  407.  
  408. 1.73ß   910628  Fixed the "key" status display after the "privil" display.
  409.                 Fixed some small bugs... nothing of interest. :-)
  410.  
  411. 1.74    910702  Minor release, some small display glitches fixed.
  412.  
  413. 1.75ß1  910716  Additional SNOOP default ON parameter "-S+" implemented.
  414.  
  415. 1.75    910725  Release version with the SNOOP parameter implemented.
  416.                 Use this with the "%W" XTERN_??? menu-command in MAX.102.abk.9
  417.  
  418. 1.76ß1..1E1234  Too much to meantion...
  419.  
  420. 1.76    910909  Fixed some minor glitches in the "Terminate (Y/n)" logic.
  421.                 Fixed the "More? (Y/n/=)" glitch wich would default to "="
  422.                 if you perform a new search without loading Mlocate again.
  423.                 Speed is 0 to 500% faster when searching for files.
  424.  
  425.  
  426. Known bugs:     The intelligence in the date-routines is too poor,
  427.                 not really a bug, it will be improved, sometime...
  428.                 
  429.   ---------------------------------------------------------------------------
  430.  
  431.   Thanx to:
  432.                 Scott Dudley, for his excellent Maximus CBCS.
  433.                 Patrik (aka Putte) Sjöberg, for his outstanding FEBBS.
  434.                 Fritte, my cat, who heelpedd em iwth te wrtiing (ouch).
  435.                 Mattias Pantzare, for the *FAST* crc32 routine.
  436.                 Skogs-Ola Norström, for inspiration.
  437.                 My brother, for fixing my broken car.
  438.                 Kicki Ahlinder, "i just looove you..." <tm_birch>
  439.                 Mats Birch, for being such a good looser in biljard. :-)
  440.                 LG, for the beer.
  441.                 Joaquim Homrighausen, for FD.
  442.                 Peter "Peppe" Laur, for all those crazy ideas.
  443.                 "The Pizza", for being such a #$@!&%...
  444.                 
  445.   ---------------------------------------------------------------------------
  446.  
  447.